Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(customers): CUST-3623 update customers api docs based on cursor pagination #769

Merged
merged 4 commits into from
Jan 28, 2025
Merged

chore(customers): CUST-3623 update customers api docs based on cursor pagination #769

merged 4 commits into from
Jan 28, 2025

Conversation

isaacchen-bc
Copy link
Contributor

@isaacchen-bc isaacchen-bc commented Jan 22, 2025 •
edited
Loading

CUST-3623

What changed?

  • update v3 get customers api docs based on cursor pagination
  • update v3 get ffvs api docs based on cursor pagination
  • correct the value of meta for v3 post/put customers

Screenshots from swagger.io

get customers:

Screenshot 2025-01-23 at 11 15 39 AM Screenshot 2025-01-23 at 11 15 48 AM Screenshot 2025-01-23 at 11 16 39 AM Screenshot 2025-01-23 at 11 16 50 AM

get ffvs:

Screenshot 2025-01-23 at 11 17 38 AM Screenshot 2025-01-23 at 11 17 45 AM Screenshot 2025-01-23 at 11 17 57 AM Screenshot 2025-01-23 at 11 18 07 AM

Release notes draft

  • Feature: Cursor pagination is now available to Customers V3 - Get All Customers
  • Feature: Cursor pagination is now available to Customers V3 - Get Customer Form Field Values
  • Fixed: Corrected the value of meta for the response of Customers V3 - Create/Update Customers

@isaacchen-bc isaacchen-bc force-pushed the CUST-3623 branch 2 times, most recently from 6c92587 to 758c119 Compare January 23, 2025 00:13
@isaacchen-bc isaacchen-bc changed the title chore(customers): CUST-3623 update get customers api docs based on cursor pagination chore(customers): CUST-3623 update customers api docs based on cursor pagination Jan 23, 2025
bc-traciporter
bc-traciporter reviewed Jan 23, 2025
View reviewed changes
Copy link
Collaborator

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some editorial comments to remove passive voice.

@isaacchen-bc isaacchen-bc marked this pull request as ready for review January 24, 2025 01:44
bc-akshatkaushik
bc-akshatkaushik previously approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@bc-akshatkaushik bc-akshatkaushik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestion but otherwise LGTM 💯

snaderiBC
snaderiBC previously approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@snaderiBC snaderiBC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Isaac 👏
Looking good 🚢

bc-akshatkaushik
bc-akshatkaushik approved these changes Jan 28, 2025
View reviewed changes
Copy link
Contributor

@bc-akshatkaushik bc-akshatkaushik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@isaacchen-bc isaacchen-bc merged commit da6cc69 into main Jan 28, 2025
3 checks passed
@isaacchen-bc isaacchen-bc deleted the CUST-3623 branch January 28, 2025 04:30
@bc-traciporter
Copy link
Collaborator

Hi @bc-akshatkaushik I plan to add this change to the release notes tomorrow. Here is my draft copy:

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update simplifies navigation and supports more complex queries.

@isaacchen-bc
Copy link
Contributor Author

Hi @bc-akshatkaushik I plan to add this change to the release notes tomorrow. Here is my draft copy:

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update simplifies navigation and supports more complex queries.

Thanks for the draft @bc-traciporter! Just a bit of context for this. The reason why we introduce cursor pagination is that when users use it to navigate through the results, the performance would be drastically improved, especially when the store has a lot of customers or form field values.

@bc-traciporter
Copy link
Collaborator

@bc-akshatkaushik Thanks for the feedback. I will change the text slightly.

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update improves navigation performance and supports many customers or form field values.

@github-actions github-actions bot mentioned this pull request Jan 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bc-traciporter bc-traciporter bc-traciporter left review comments

@bc-akshatkaushik bc-akshatkaushik bc-akshatkaushik approved these changes

@snaderiBC snaderiBC snaderiBC left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@isaacchen-bc @bc-traciporter @snaderiBC @bc-akshatkaushik